Documentation improvements #584
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Co-authored-by: Vodrix <[email protected]>
|
Nightly build for this pull request:
|
Metadorius
reviewed
Nov 25, 2024
|
Good work but I suggest using the syntax that is used in Phobos and Vinifera, as it is easily copypaste-able into the INIs. You can see the examples in the Phobos or Vinifera docs for new features, I would imagine the docs looking like the following: #### [XNAControl](link)
- Some text describing what is it
- Some details
```ini
[SOMECONTROL] ; XNAControl
X=0 ; integer
Y=0 ; integer
; ...
Enabled=true ; boolean, whether the control can be interacted with
; ...
``` |
Co-authored-by: Metadorius <[email protected]> Co-authored-by: Kerbiter <[email protected]>
Co-authored-by: Metadorius <[email protected]>
|
Thanks for advise. |
Metadorius
requested changes
Nov 26, 2024
Docs/INISystem.md
Outdated
| Width=25 ; integer, the Width of the control. | ||
| Height=10 ; integer, the Height of the control. | ||
| Size=60,30 ; 2 integers, the Width and Height of the control. | ||
| Text=Some Text@Example ; text, the text to display for the control (ex: buttons, labels, etc...). |
There was a problem hiding this comment.
The values should contain default values or no values, if there is no default value. This will ensure that a config maker could copy-paste the reference INI code and have nothing changed in the behavior
Metadorius
reviewed
Nov 26, 2024
Co-authored-by: Metadorius <[email protected]>
Co-authored-by: Kerbiter <[email protected]>
Co-authored-by: Metadorius <[email protected]>
Metadorius
reviewed
Nov 26, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
PR updates documentation style and makes significant improvement in
INISystem.mdfile.Changelog:
**Note**replaced to[!NOTE][!WARNING]